Skip to main content
SnapCenter software
日本語は機械翻訳による参考訳です。内容に矛盾や不一致があった場合には、英語の内容が優先されます。

Swagger API WebページからREST APIにアクセスする方法

PDF

REST APIはSwagger Webページから利用できます。Swagger Webページにアクセスして、SnapCenter Server REST APIを表示したり、APIを手動で呼び出したりすることができます。REST APIを使用して、SnapCenter Serverの管理やデータ保護処理を行うことができます。

REST APIを実行するSnapCenter Serverの管理IPアドレスまたはドメイン名を確認しておく必要があります。

REST APIクライアントを実行するために特別な権限は必要ありません。すべてのユーザがSwagger Webページにアクセスできます。REST APIでアクセスするオブジェクトに対する権限は、REST APIへのログインに使用するトークンを生成したユーザに基づきます。

手順

  1. ブラウザから、https://<SnapCenter_IP_address_or_name>:<SnapCenter_port>/swagger/ の形式で Swagger Web ページにアクセスするための URL を入力します。

    メモ REST API URL に +、.、%、& の文字が含まれていないことを確認します。

  2. Swagger Explore フィールドに、Swagger API ドキュメントが自動的に表示されない場合は、次のように入力します: https://<SnapCenter_IP_address_or_name>:<SnapCenter_port>/Content/swagger/ SnapCenter.yaml

  3. *探索*をクリックします。

    APIリソース タイプ（カテゴリ）の一覧が表示されます。

  4. APIリソース タイプをクリックすると、そのリソース タイプのAPIが表示されます。

SnapCenter REST APIの実行時に予期しない動作が発生した場合は、ログ ファイルで原因を特定して問題を解決することができます。モニター > ログ > ダウンロード をクリックすると、 SnapCenterユーザー インターフェイスからログ ファイルをダウンロードできます。